<meta charset="utf-8">
(#) ProtoLayout feature is not guaranteed to be available on the target device API

!!! ERROR: ProtoLayout feature is not guaranteed to be available on the target device API
   This is an error.

Id
:   `ProtoLayoutMinSchema`
Summary
:   ProtoLayout feature is not guaranteed to be available on the target device API
Severity
:   Error
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Identifier
:   androidx.wear.protolayout
Feedback
:   https://issuetracker.google.com/issues/new?component=1112273
Min
:   Lint 8.7+
Compiled
:   Lint 8.7+
Artifact
:   [androidx.wear.protolayout:protolayout](androidx_wear_protolayout_protolayout.md.html)
Since
:   1.1.0
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/wear/protolayout/protolayout-lint/src/main/java/androidx/wear/protolayout/lint/ProtoLayoutMinSchemaDetector.kt)
Tests
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/wear/protolayout/protolayout-lint/src/test/java/ProtoLayoutMinSchemaDetectorTest.kt)
Copyright Year
:   2023

Using features that are not supported by an older ProtoLayout
renderer/evaluator, can lead to unexpected rendering or invalid results
(for expressions).

Each Wear OS platform version has a guaranteed minimum ProtoLayout
schema version.
On API 33, all consumers for ProtoLayout support at least Schema version
1.2 (major=1, minor=200).
On API 34, all consumers for ProtoLayout support at least Schema version
1.3 (major=1, minor=300).

You can use those newer features through conditional Android API checks,
or by increasing the minSdk for your project.
You can also annotate your methods with @RequiresApi or
@RequiresSchemaAnnotation if you know they require the
corresponding version.
Note that @RequiresSchemaVersion annotation on classes are mostly
ignored (except for Builder classes).

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/foo/Bar.kt:6:Error: This API is not guaranteed to be available on
the device (requires schema 1.200). [ProtoLayoutMinSchema]
  private val fieldAssignment = withAnnotation.annotatedMethod()
                                --------------------------------
src/foo/Bar.kt:12:Error: This API is not guaranteed to be available on
the device (requires schema 1.200). [ProtoLayoutMinSchema]
    bar()
    -----
src/foo/Bar.kt:14:Error: This API is not guaranteed to be available on
the device (requires schema 1.200). [ProtoLayoutMinSchema]
    withAnnotation.annotatedMethod()
    --------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here are the relevant source files:

`src/foo/WithAnnotation.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package foo
import androidx.wear.protolayout.expression.RequiresSchemaVersion

@RequiresSchemaVersion(major=1, minor=200)
class WithAnnotation {
  fun unAnnotatedMethod(){}

  @RequiresSchemaVersion(major=1, minor=200)
  fun annotatedMethod(){}

  @RequiresSchemaVersion(major=1, minor=200)
  fun unreferencedMethod(){}

  companion object {
    @RequiresSchemaVersion(major=1, minor=200)
    const val ANNOTATED_CONST = 10
  }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`src/foo/Bar.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package foo
import androidx.wear.protolayout.expression.RequiresSchemaVersion

class Bar {
  private val withAnnotation = WithAnnotation()
  private val fieldAssignment = withAnnotation.annotatedMethod()

  @RequiresSchemaVersion(major=1, minor=200)
  fun bar() {}

  fun baz() {
    bar()
    withAnnotation.unAnnotatedMethod()
    withAnnotation.annotatedMethod()
    //TODO: b/308552481 - This should fail
    val b = withAnnotation.ANNOTATED_CONST
  }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/wear/protolayout/protolayout-lint/src/test/java/ProtoLayoutMinSchemaDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `ProtoLayoutMinSchemaDetector.calling V1_2 API requires SDK version check`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=1112273.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.wear.protolayout:protolayout:1.3.0-alpha05")

// build.gradle
implementation 'androidx.wear.protolayout:protolayout:1.3.0-alpha05'

// build.gradle.kts with version catalogs:
implementation(libs.protolayout)

# libs.versions.toml
[versions]
protolayout = "1.3.0-alpha05"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
protolayout = {
    module = "androidx.wear.protolayout:protolayout",
    version.ref = "protolayout"
}
```

1.3.0-alpha05 is the version this documentation was generated from;
there may be newer versions available.

NOTE: These lint checks are **also** made available separate from the main library.
Use one of the following artifacts:
* `androidx.wear.protolayout:protolayout-expression:1.3.0-alpha05`
* `androidx.wear.protolayout:protolayout-material3:1.3.0-alpha05`
* `androidx.wear.protolayout:protolayout-material:1.3.0-alpha05`


[Additional details about androidx.wear.protolayout:protolayout](androidx_wear_protolayout_protolayout.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("ProtoLayoutMinSchema")
  fun method() {
     problematicStatement()
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("ProtoLayoutMinSchema")
  void method() {
     problematicStatement();
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection ProtoLayoutMinSchema
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="ProtoLayoutMinSchema" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'ProtoLayoutMinSchema'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore ProtoLayoutMinSchema ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>